PUT api/DataNodes/Command?ids[0]={ids[0]}&ids[1]={ids[1]}&cmd[0]={cmd[0]}&cmd[1]={cmd[1]}

Sends a custom command through to the input DataNodes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ids

Array of DataNodeIntID to send commands to

Collection of integer

Required

cmd

Array of commands to send to the DataNodes, respective to their indices

Collection of string

Required

Body Parameters

None.

Response Information

Resource Description

GetDataNodeCommandResponse
NameDescriptionTypeAdditional information
DataNodeCommandResponses

Array of DataNode Command Responses

Collection of DataNodeCommandResponse

None.

Messages

Array of messages

Collection of Message

None.

ServerInformation

Relevant information regarding the Server

ServerInformation

None.

VersionInformation

Relevant information regarding the API's version

VersionInformation

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "DataNodeCommandResponses": [
    {
      "DataNodeIntID": 1,
      "ReturnCode": 2,
      "CommandResponse": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "DataNodeIntID": 1,
      "ReturnCode": 2,
      "CommandResponse": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:36:43.9379566+10:00",
    "BuildDateUTC": "2025-11-09T21:36:43.9379566+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:
<GetDataNodeCommandResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:36:43.9379566+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:36:43.9379566+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <DataNodeCommandResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.DataNodeCommandResponse>
      <d2p1:CommandResponse xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CommandResponse>
      <d2p1:DataNodeIntID>1</d2p1:DataNodeIntID>
      <d2p1:ReturnCode>2</d2p1:ReturnCode>
    </d2p1:APIStructs.DataNodeCommandResponse>
    <d2p1:APIStructs.DataNodeCommandResponse>
      <d2p1:CommandResponse xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:CommandResponse>
      <d2p1:DataNodeIntID>1</d2p1:DataNodeIntID>
      <d2p1:ReturnCode>2</d2p1:ReturnCode>
    </d2p1:APIStructs.DataNodeCommandResponse>
  </DataNodeCommandResponses>
</GetDataNodeCommandResponse>